home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / SgFinder.z / SgFinder
Text File  |  1998-10-30  |  20KB  |  331 lines
  1.  
  2.  
  3.  
  4.      SSSSggggFFFFiiiinnnnddddeeeerrrr((((3333XXXX))))              UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV              SSSSggggFFFFiiiinnnnddddeeeerrrr((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           SSSSggggFFFFiiiinnnnddddeeeerrrr - The Finder widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<SSSSggggmmmm////FFFFiiiinnnnddddeeeerrrr....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents the version of Sgm that accompanies
  17.           Motif 2.1.
  18.  
  19.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.           The Finder widget is designed to integrate a drop pocket, a
  21.           textField, a zoomBar, and a history menu.  The zoomBar is a
  22.           set of buttons above the text field which allows sections of
  23.           the text to be selected.  The history menu allows users to
  24.           select items previously visited, or to undo operations.  The
  25.           Finder widget should be used for accelerating text selection
  26.           of long objects such as file names.
  27.  
  28.           Pressing on the history button brings up a pulldown menu of
  29.           choices.  Selecting an item in the menu will set the text
  30.           field to that item.  Whenever the text field is set, the
  31.           zoomBar changes to reflect the text sections in the text
  32.           field.
  33.  
  34.           Pressing a button on the zoomBar will set the text field to
  35.           the portion of the text preceding that button.  The specific
  36.           behavior is customizable, but generally will cut-off the
  37.           portion of the text after the pressed zoomBar button.  The
  38.           history menu can always be used to go back to the original
  39.           text.
  40.  
  41.           The Finder also includes a DropPocket for displaying icons
  42.           representing entries in the Finder's text field.  These
  43.           icons are sgi file icons.  File icons from fm, searchbook or
  44.           similar applications can be dropped on the DropPocket.
  45.  
  46.           The Finder widget includes resources that allow initializing
  47.           the history list, setting the pixmap on the history button,
  48.           and providing a custom function for handling setting of the
  49.           text after a zoomBar button press.  Other resources are
  50.           described below. It is customizable for various
  51.           applications.
  52.  
  53.         CCCCllllaaaasssssssseeeessss
  54.           Finder inherits behavior and resources from CCCCoooorrrreeee, CCCCoooommmmppppoooossssiiiitttteeee,
  55.           CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt and XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr.
  56.  
  57.           The class pointer is ssssggggFFFFiiiinnnnddddeeeerrrrWWWWiiiiddddggggeeeettttCCCCllllaaaassssssss.
  58.  
  59.           The class name is SSSSggggFFFFiiiinnnnddddeeeerrrr.
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      SSSSggggFFFFiiiinnnnddddeeeerrrr((((3333XXXX))))              UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV              SSSSggggFFFFiiiinnnnddddeeeerrrr((((3333XXXX))))
  71.  
  72.  
  73.  
  74.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  75.           The following table defines a set of widget resources used
  76.           by the programmer to specify data.  The programmer can also
  77.           set the resource values for the inherited classes to set
  78.           attributes for this widget.  To reference a resource by name
  79.           or by class in a .Xdefaults file, remove the SSSSggggNNNN or SSSSggggCCCC
  80.           prefix and use the remaining letters.  To specify one of the
  81.           defined values for a resource in a .Xdefaults file, remove
  82.           the SSSSggggNNNN prefix and use the remaining letters (in either
  83.           lowercase or uppercase, but include any underscores between
  84.           words).  The codes in the access column indicate if the
  85.           given resource can be set at creation time (C), set by using
  86.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  87.           not applicable (N/A).
  88.  
  89.                                           SSSSggggFFFFiiiinnnnddddeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  90.      NNNNaaaammmmeeee                      CCCCllllaaaassssssss                   TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  91.      ________________________________________________________________________________________________
  92.      XmNactivateCallback       XmCCallback             XtCallbackList   NULL                   C
  93.      SgNhistoryPixmap          XmCHistoryPixmap        Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  94.      SgNseparator              SgCSeparator            unsigned char    '/'                    CSG
  95.      SgNsetTextSectionFunc     SgCSetTextSectionFunc   XtProc           setTextSection         CSG
  96.      SgNuseDropPocket          SgCUseDropPocket        Boolean          True                   CG
  97.      SgNuseHistoryMenu         SgCUseHistoryMenu       Boolean          True                   CG
  98.      XmNvalueChangedCallback   XmCCallback             XtCallbackList   NULL                   C
  99.  
  100.  
  101.           XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk
  102.                     This callback is called when a zoomBar button is
  103.                     pushed or when the text field generates an
  104.                     activateCallback (i.e. a return in the text field)
  105.                     or if the text field is set by
  106.                     SSSSggggFFFFiiiinnnnddddeeeerrrrSSSSeeeettttTTTTeeeexxxxttttSSSSttttrrrriiiinnnngggg.  The type of the structure
  107.                     whose address is passed to this callback is
  108.                     XXXXmmmmAAAAnnnnyyyyCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt.  The reason sent by the
  109.                     callback is XXXXmmmmCCCCRRRR____AAAACCCCTTTTIIIIVVVVAAAATTTTEEEE.
  110.  
  111.           SSSSggggNNNNhhhhiiiissssttttoooorrrryyyyPPPPiiiixxxxmmmmaaaapppp
  112.                     The pixmap that is displayed on the history
  113.                     button.
  114.  
  115.           SSSSggggNNNNsssseeeeppppaaaarrrraaaattttoooorrrr
  116.                     The character that is used to separate sections of
  117.                     text.  The default is '/'.  This character
  118.                     determines where the buttons on the zoomBar are.
  119.                     The sections of text each generate one button, and
  120.                     are defined by the SSSSggggNNNNsssseeeeppppaaaarrrraaaattttoooorrrr at the end of each
  121.                     section.
  122.  
  123.           SSSSggggNNNNsssseeeettttTTTTeeeexxxxttttSSSSeeeeccccttttiiiioooonnnnFFFFuuuunnnncccc
  124.                     This resource is used to replace the default
  125.                     behavior of zoomBar button pushes with a user-
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      SSSSggggFFFFiiiinnnnddddeeeerrrr((((3333XXXX))))              UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV              SSSSggggFFFFiiiinnnnddddeeeerrrr((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                     defined function.  The typedef for the function is
  141.                     in <<<<SSSSgggg////FFFFiiiinnnnddddeeeerrrr....hhhh>>>>.  The function should have return
  142.                     type vvvvooooiiiidddd and take an SSSSggggFFFFiiiinnnnddddeeeerrrrWWWWiiiiddddggggeeeetttt and and iiiinnnntttt
  143.                     as arguments which are passed to it when it is
  144.                     called.  The SSSSggggNNNNsssseeeettttTTTTeeeexxxxttttSSSSeeeeccccttttiiiioooonnnnFFFFuuuunnnncccc function is
  145.                     called whenever a zoomBar button is pushed.  It is
  146.                     suggested that SSSSggggFFFFiiiinnnnddddeeeerrrrSSSSeeeettttTTTTeeeexxxxttttSSSSttttrrrriiiinnnngggg be used in
  147.                     the SSSSggggNNNNsssseeeettttTTTTeeeexxxxttttSSSSeeeeccccttttiiiioooonnnnFFFFuuuunnnncccc to set the value of the
  148.                     text field after a push occurs.
  149.  
  150.           SSSSggggNNNNuuuusssseeeeDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt
  151.                     Determines whether to create a SgDropPocketWidget
  152.                     child of the Finder.  If SSSSggggNNNNuuuusssseeeeDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt is True
  153.                     (the default), the widget appears to the left of
  154.                     the text field.  If it is set to false at creation
  155.                     time, no drop pocket is created, and the
  156.                     functionality associated with the drop pocket is
  157.                     unavailable.  This resource can be used to bypass
  158.                     the costs of setting up drag and drop and loading
  159.                     the fileicon libraries.
  160.  
  161.           SSSSggggNNNNuuuusssseeeeHHHHiiiissssttttoooorrrryyyyMMMMeeeennnnuuuu
  162.                     If SSSSggggNNNNuuuusssseeeeHHHHiiiissssttttoooorrrryyyyMMMMeeeennnnuuuu is True (the default), the
  163.                     widget appears to the right of the text field.  If
  164.                     it is set to false at creation time, no SgDynaMenu
  165.                     widget is created and there will be no history
  166.                     mechanism for the finder.  The associated
  167.                     functions to manipulate the history menu,
  168.                     SSSSggggFFFFiiiinnnnddddeeeerrrrAAAAddddddddHHHHiiiissssttttoooorrrryyyyIIIItttteeeemmmm and SSSSggggFFFFiiiinnnnddddeeeerrrrCCCClllleeeeaaaarrrrHHHHiiiissssttttoooorrrryyyy
  169.                     will not do anything, but can still be called
  170.                     safely.
  171.  
  172.           XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk
  173.                     The value changed callback specifies the list of
  174.                     callbacks that is called after text is deleted
  175.                     from or inserted into the text field.  The type of
  176.                     the structure whose address is passed to this
  177.                     callback is XXXXmmmmAAAAnnnnyyyyCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt.  The reason sent
  178.                     by the callback is XXXXmmmmCCCCRRRR____VVVVAAAALLLLUUUUEEEE____CCCCHHHHAAAANNNNGGGGEEEEDDDD.
  179.  
  180.  
  181.  
  182.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  183.           Finder inherits behavior and resources from CCCCoooorrrreeee, CCCCoooommmmppppoooossssiiiitttteeee,
  184.           CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt, and XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr.
  185.  
  186.                                           XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  187.      NNNNaaaammmmeeee                    CCCCllllaaaassssssss                   TTTTyyyyppppeeee                DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  188.      _________________________________________________________________________________________________
  189.      XmNbottomShadowColor    XmCBottomShadowColor    Pixel               dynamic                CSG
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                         (printed 10/24/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      SSSSggggFFFFiiiinnnnddddeeeerrrr((((3333XXXX))))              UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV              SSSSggggFFFFiiiinnnnddddeeeerrrr((((3333XXXX))))
  203.  
  204.  
  205.  
  206.      XmNbottomShadowPixmap   XmCBottomShadowPixmap   Pixmap              XmUNSPECIFIED_PIXMAP   CSG
  207.      XmNforeground           XmCForeground           Pixel               dynamic                CSG
  208.      XmNhelpCallback         XmCCallback             XtCallbackList      NULL                   C
  209.      XmNhighlightColor       XmCHighlightColor       Pixel               dynamic                CSG
  210.      XmNhighlightPixmap      XmCHighlightPixmap      Pixmap              dynamic                CSG
  211.      XmNinitialFocus         XmCInitialFocus         Widget              dynamic                CSG
  212.      XmNnavigationType       XmCNavigationType       XmNavigationType    XmTAB_GROUP            CSG
  213.      XmNshadowThickness      XmCShadowThickness      Dimension           dynamic                CSG
  214.      XmNstringDirection      XmCStringDirection      XmStringDirection   dynamic                CG
  215.      XmNtopShadowColor       XmCTopShadowColor       Pixel               dynamic                CSG
  216.      XmNtopShadowPixmap      XmCTopShadowPixmap      Pixmap              dynamic                CSG
  217.      XmNtraversalOn          XmCTraversalOn          Boolean             True                   CSG
  218.      XmNunitType             XmCUnitType             unsigned char       dynamic                CSG
  219.      XmNuserData             XmCUserData             XtPointer           NULL                   CSG
  220.  
  221.                              CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  222.      NNNNaaaammmmeeee                CCCCllllaaaassssssss               TTTTyyyyppppeeee          DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  223.      ______________________________________________________________________
  224.      XmNchildren         XmCReadOnly         WidgetList    NULL      G
  225.      XmNinsertPosition   XmCInsertPosition   XtOrderProc   NULL      CSG
  226.      XmNnumChildren      XmCReadOnly         Cardinal      0         G
  227.  
  228.                                                    CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  229.      NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  230.      ______________________________________________________________________________________________________________
  231.      XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                N/A
  232.      XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  233.      XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  234.      XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  235.      XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  236.      XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  237.      XmNborderWidth                  XmCBorderWidth                  Dimension        0                      CSG
  238.      XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  239.      XmNdepth                        XmCDepth                        int              dynamic                CG
  240.      XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  241.      XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  242.      XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  243.      XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  244.      XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  245.      XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  246.      XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  247.      XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  248.      XmNx                            XmCPosition                     Position         0                      CSG
  249.      XmNy                            XmCPosition                     Position         0                      CSG
  250.  
  251.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  252.           CCCCoooorrrreeee((((3333XXXX)))), SSSSggggCCCCrrrreeeeaaaatttteeeeFFFFiiiinnnnddddeeeerrrr((((3333XXXX)))), SSSSggggFFFFiiiinnnnddddeeeerrrrAAAAddddddddHHHHiiiissssttttoooorrrryyyyIIIItttteeeemmmm((((3333XXXX)))),
  253.           SSSSggggFFFFiiiinnnnddddeeeerrrrCCCClllleeeeaaaarrrrHHHHiiiissssttttoooorrrryyyy((((3333XXXX)))), SSSSggggFFFFiiiinnnnddddeeeerrrrGGGGeeeettttTTTTeeeexxxxttttSSSSttttrrrriiiinnnngggg((((3333XXXX)))),
  254.           SSSSggggFFFFiiiinnnnddddeeeerrrrSSSSeeeettttTTTTeeeexxxxttttSSSSttttrrrriiiinnnngggg((((3333XXXX)))), SSSSggggFFFFiiiinnnnddddeeeerrrrGGGGeeeettttCCCChhhhiiiilllldddd((((3333XXXX)))),
  255.           SSSSggggDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt((((3333XXXX)))), XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeelllldddd((((3333XXXX)))), and XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr((((3333XXXX)))).
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                         (printed 10/24/98)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      SSSSggggFFFFiiiinnnnddddeeeerrrr((((3333XXXX))))              UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV              SSSSggggFFFFiiiinnnnddddeeeerrrr((((3333XXXX))))
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.      Page 5                                         (printed 10/24/98)
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.